Effects Parameters

The options on the dialog are mostly self explanatory. The only one that
needs further explanation is the "Parameters" option. Parameters are semi-
colon delimited. The available parameters are:

RANDOM=random_range,random_threshold;

Specifies that the effect occurs randomly. A random number is
generated between 0 and random_range; if the number generated
is less than random_threshold, the effect is not created.


x = random number from 0 to "random_range"
if (x < random_threshold) do nothing

For a 10% chance of seeing a certain effect:

RANDOM=10,9

40% chance:

RANDOM=10,6



YEAR=year_begin,year_end;

Specifies that the effect occurs only if the sim time is within
the year range, inclusively.
To have an effect play for the year 1989, the parameter would be written as:

YEAR=1989,1989


MOY=moy_begin,moy_end;
DOM=dom_begin,dom_end;
HOD=hod_begin,hod_end;
MOH=moh_begin,moh_end;
SOM=som_begin,som_end;

Specifies the months of the year (MOY), days of the month (DOM), hours of the
day (HOD), minutes of the hour (MOH), and seconds of the minute (SOM) for which the
effect occurs. All ranges are inclusive. Any combination of these
ranges may be used; the more used, the fewer valid date/times the
effect occurs. All times are in the local timezone.
MOY range: 1,12;
Where "1"= January, and "12"= December
DOM range: 1,31;
Where "1"= first day of the month, and "31"= last possible day of the month
HOD range: 0,23;
Where "0"= would be midnight
MOH range: 0,59;
Where "0"= would be the start of the duration of 60 minutes
SOM range: 0,59;
Where "0"= would be the start of the duration of 60 seconds

DAWN=1|0;
DAY=1|0;
DUSK=1|0;
NIGHT=1|0;

Specifies that the effect should only occur during certain periods
of the day. If the value is 1, the effect will occur. If the value
is 0, it will not. If none of these parameters are specified, the
effect will occur the entire day.

DURATION=seconds;

Specifies, in seconds, the duration of the effect. This parameter
my be a non-integer; i.e. 2.5.

Parameter precedence:

"RANDOM" takes highest precedence, then "DAWN," etc., and then "HOD," etc.

"RANDOM" is determined when the scenery is first loaded. If the random
check fails, the effect will not occur at all until the scenery is
completely reloaded (at which point it may fail the random check again).

It is possible to set up an effect's parameters such that the effect never
occurs. If any of the "DAWN," "DAY," etc. parameters are specified, they
take precedence over "HOD," "MOH," and "SOM." Therefore if you set
"NIGHT=0;" and "HOD=22;", the effect will not show at 10:00PM because it
should not appear at night.